Skip to content

Remove GH_TOKEN requirement#342

Merged
cachafla merged 3 commits intomainfrom
cachafla/fix-docs-gh-action
Apr 1, 2025
Merged

Remove GH_TOKEN requirement#342
cachafla merged 3 commits intomainfrom
cachafla/fix-docs-gh-action

Conversation

@cachafla
Copy link
Contributor

@cachafla cachafla commented Apr 1, 2025

Internal Notes for Reviewers

...and stop running docs.yaml (deprecated).

External Release Notes

@cachafla cachafla added the internal Not to be externalized in the release notes label Apr 1, 2025
github-actions bot and others added 2 commits April 1, 2025 18:41
…n and update Quarto documentation workflow to exclude specific branch.
@cachafla cachafla requested review from nibalizer and nrichers April 1, 2025 18:57
@github-actions
Copy link
Contributor

github-actions bot commented Apr 1, 2025

PR Summary

This pull request introduces several key changes to the documentation generation workflows and the codebase:

  1. Removal of Sphinx Documentation Workflow: The .github/workflows/docs.yaml file, which was responsible for generating Markdown documentation from docstrings using Sphinx, has been removed. This indicates a shift away from Sphinx-based documentation generation.

  2. Enhancements to Quarto Documentation Workflow: The .github/workflows/quarto-docs.yaml file has been updated to streamline the process of generating Quarto documentation. Notable changes include:

    • Removal of the release-v1 branch from the list of branches that trigger the workflow.
    • Minor formatting adjustments for consistency.
    • Removal of the token parameter from the actions/checkout step, which may indicate a change in how authentication is handled.
  3. Type Annotations Added: Type annotations have been added to several functions in the docs/validmind/tests.qmd file. This includes specifying parameter types and return types, which enhances code readability and helps with static analysis.

  4. Version Update: The version number in the documentation files has been updated from 2.8.14 to 2.8.15, reflecting a new release or patch.

These changes collectively improve the documentation process and enhance code quality through better type safety.

Test Suggestions

  • Verify that the Quarto documentation workflow runs successfully on the main branch.
  • Check that the removal of the Sphinx documentation workflow does not affect other parts of the CI/CD pipeline.
  • Ensure that the type annotations added to the functions in docs/validmind/tests.qmd are correct and do not cause any runtime errors.
  • Test the documentation generation process to confirm that the output is as expected and includes all necessary information.
  • Validate that the version update is correctly reflected in all relevant parts of the documentation.

@cachafla
Copy link
Contributor Author

cachafla commented Apr 1, 2025

(I tested that the GH action works on a previous commit)

Copy link
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🚀

(At some point, I'd like to put the Quarto docs stuff into a separate repo and maintain it there as a separate component we install via poetry, assuming you're agreeable to that.)

@cachafla cachafla merged commit d9398e8 into main Apr 1, 2025
7 checks passed
@cachafla cachafla deleted the cachafla/fix-docs-gh-action branch April 1, 2025 19:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants